package org.dlsu.mt;

/**
 * This interface provides methods for tokenizing an entire document into sentences.
 * To use this interface we set first set the document to parse then iterate through using
 * hasMoreSentences as loop condition in a while loop, and nextSentence() to move to the next sentence
 * and retrieve the sentence.
 *
 * <code>
 *		SentenceTokenizerInterface senTok = ...;
 *		senTok.setDocument(MY_DOCUMENT);
 *		while(senTok.hasMoreSentences())
 *			String sentence = senTok.nextSentence();
 * </code>
 */
public interface SentenceTokenizerInterface {
	/**
	 * Sets the document to tokenize
	 *
	 * @param document The document to tokenize
	 */
	public void setDocument(Object document);
	/**
	 * Gets the next sentence from the set document using setDocument()
	 *
	 * @return The next sentence on the document
	 */
	public Object nextSentence();
	/**
	 * Checks if there are more sentences to return
	 *
	 * @return true if there are more sentences, false otherwise
	 */
	 public boolean hasMoreSentences();
}